.. _cmlPmMxStop:

cmlPmMxStop
================================
--------------------------------


SYNOPSYS
`````````````
.. code-block:: none

  VT_I4 cmlPmMxStop ([in] VT_I4 BoardID, [in] VT_I4 NodeId, [in] VT_I4 NumChannel, 
  [in] VT_I4 ChannelMask, [in] VT_I4 IsWaitComplete)   

DESCRIPTION
`````````````  

- 지정한 모든 축에 대한 모션을 정지(停止)합니다. cmlPmMxStop()  함수는 정지(停止)시에 감속 후 
  정지(停止)를 수행하며, cmlPmMxStopEmg() 함수는 감속없이 즉시정지(停止)를 수행합니다. 
 
\

- 이 함수의 사용과 호출에 있어, 제공된 ㈜커미조아의 함수 헤더 Visual Basic 에서는 함수의
  첨두어 cml 가 붙지 않습니다.

PARAMETER
`````````````

▶ BoardID : 사용자가 설정한 디바이스(보드) ID. 
 
▶ NodeId : 사용자가 제어하고자 하는 노드 번호. 
 
▶ NumAxes : 동시에 작업을 수행할 대상 축의 수 
 
▶ ChannelMask: 동시에 작업을 수행할 대상 축의 마스크 
 
▶ IsWaitComplete: 정지가 완료될 때까지 기다릴지의 여부를 결정한다. 
                

RETURN VALUE
`````````````

.. csv-table::
  :widths: 10 90
  :header-rows: 1
  :stub-columns: 0

  Value, Meaning
  음수, 수행 실패
  ERR_NONE, 수행 성공

REFERENCE
`````````````

.. note:: "윈도우 이벤트라는 것은 무엇입니까?"
    윈도우 운영체제는 Event Driven 혹은 Message Driven 방식의 구조로 되어 
    있습니다. 각 응용프로그램은 메시지 큐(Queue)를 가지고 있으며, 정확히 
    말하면, 메시지를 사용해 이벤트를 통지하는 방식으로 설계되어 있습니다. 
    윈도우 메시지를 처리한다는 것은 메시지 큐에서 메시지를 하나씩 꺼내서 
    윈도우 프로시저에 전송한다는 것을 의미하며, 이것은 그 행선지가 되는 
    윈도우에 전송되어 처리됩니다. 

EXAMPLE
`````````

.. code-block:: c++
 :linenos:
 :emphasize-lines: 5

  C/C++  
  void CmlMotionDlg::OnStop()  
  { 
  long BoardID = 0; 
  long nAxes=0x3; //0,1 번 축을 정지시킵니다. 
  GetDlgItcml(IDC_btnStop)->EnableWindow(FALSE); 
  cmlPmMxStop(BoardID, 0, 2, nAxes, TRUE, FALSE); 
  GetDlgItcml(IDC_btnStop)->EnableWindow(TRUE); 
  } 

.. code-block:: c++
 :linenos:

  Visual Basic 
  `BoardID 는 0이라고 가정합니다. 
  Private Sub btnStop_Click()     
  Dim nRetVal As Long 
  Dim NumChannel(2) As Long 
  NumChannel(0) = 0 
  NumChannel(1) = 1 
  ' PmMxStop(BoardID,  축 갯수, 배열, 완료대기여부, 블록여부) 
  nRetVal = PmMxStop(BoardID, 0, 2, NumChannel(0), True, GetIsBlocking())    
  End Sub  

.. code-block:: c++
 :linenos:

  Delphi 
  // * Description : 
  // * 이 함수는 버튼 이벤트에 의해 모션 동작을 정지(停止)하는 함수입니다. 
  // * BoardID는 0이라고 가정합니다. 
  procedure btnStopClick(); 
  var 
  NumChannel : Array[0..1] of LongInt; 
  gnTargetAxis : LongInt; 
  begin 
  NumChannel[0] := 0; 
  NumChannel[1] := cmY1; 
  gnTargetAxis := 2; 
  // 정지(停止) 함수의 원형은 cmlMxSxStop([TargetAxis], [IsWaitComplete],   
  // [IsBlocking]) 입니다. 
  // TargetAxis : 정지(停止) 할 대상 축을 설정합니다. 
  // IsWaitComplete : 대상 축이 완전히 정지(停止)할 때 까지  
  //함수 반환을 하지 않습니다. 
  // IsBlocking : 함수의 동작시 윈도우 메시지 처리의 여부를 판단합니다. 
  // cmlFALSE 시에는 윈도우 메시지를 함수 내부에서 처리해주게 됩니다. 
  //  보다 자세한 설명은 매뉴얼을 참고해주시기 바랍니다. 
  cmlPmMxStop(BoardID, 0, gnTargetAxis, @NumChannel, cmlTRUE,  cmlFALSE); 
  end;